<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GMimeDataWrapper: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="DataWrappers.html" title="Data Wrappers">
<link rel="prev" href="DataWrappers.html" title="Data Wrappers">
<link rel="next" href="Headers.html" title="Message and MIME Headers">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GMimeDataWrapper.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GMimeDataWrapper.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DataWrappers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DataWrappers.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Headers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GMimeDataWrapper"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GMimeDataWrapper.top_of_page"></a>GMimeDataWrapper</span></h2>
<p>GMimeDataWrapper — Content objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GMimeDataWrapper.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-new" title="g_mime_data_wrapper_new ()">g_mime_data_wrapper_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-new-with-stream" title="g_mime_data_wrapper_new_with_stream ()">g_mime_data_wrapper_new_with_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-stream" title="g_mime_data_wrapper_set_stream ()">g_mime_data_wrapper_set_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-get-stream" title="g_mime_data_wrapper_get_stream ()">g_mime_data_wrapper_get_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding" title="g_mime_data_wrapper_set_encoding ()">g_mime_data_wrapper_set_encoding</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a>
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-get-encoding" title="g_mime_data_wrapper_get_encoding ()">g_mime_data_wrapper_get_encoding</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ssize_t</span>
</td>
<td class="function_name">
<a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-write-to-stream" title="g_mime_data_wrapper_write_to_stream ()">g_mime_data_wrapper_write_to_stream</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeDataWrapper.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GMimeDataWrapper.html#GMimeDataWrapper-struct" title="struct GMimeDataWrapper">GMimeDataWrapper</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GMimeDataWrapper.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GMimeDataWrapper
</pre>
</div>
<div class="refsect1">
<a name="GMimeDataWrapper.description"></a><h2>Description</h2>
<p>A <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> is a wrapper object for a <a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a>'s body,
allowing clients to read the content from the backing stream
without having to know whether it is encoded/compressed/etc and not
neding to know how to undo said encoding(s).</p>
</div>
<div class="refsect1">
<a name="GMimeDataWrapper.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="g-mime-data-wrapper-new"></a><h3>g_mime_data_wrapper_new ()</h3>
<pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *
g_mime_data_wrapper_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> object.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-new.returns"></a><h4>Returns</h4>
<p> a new data wrapper object.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-data-wrapper-new-with-stream"></a><h3>g_mime_data_wrapper_new_with_stream ()</h3>
<pre class="programlisting"><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="returnvalue">GMimeDataWrapper</span></a> *
g_mime_data_wrapper_new_with_stream (<em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>,
                                     <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);</pre>
<p>Creates a new <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> object around <em class="parameter"><code>stream</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-new-with-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>encoding</p></td>
<td class="parameter_description"><p>stream's encoding</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-data-wrapper-new-with-stream.returns"></a><h4>Returns</h4>
<p> a data wrapper around <em class="parameter"><code>stream</code></em>
. Since the wrapper owns its
own reference on the stream, caller is responsible for unrefing
its own copy.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-data-wrapper-set-stream"></a><h3>g_mime_data_wrapper_set_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_data_wrapper_set_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
                                <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
<p>Replaces the wrapper's internal stream with <em class="parameter"><code>stream</code></em>
. Don't forget,
if <em class="parameter"><code>stream</code></em>
 is not of the same encoding as the old stream, you'll
want to call <a class="link" href="GMimeDataWrapper.html#g-mime-data-wrapper-set-encoding" title="g_mime_data_wrapper_set_encoding ()"><code class="function">g_mime_data_wrapper_set_encoding()</code></a> as well.</p>
<p>Note: caller is responsible for its own reference on
<em class="parameter"><code>stream</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-set-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wrapper</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-data-wrapper-get-stream"></a><h3>g_mime_data_wrapper_get_stream ()</h3>
<pre class="programlisting"><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="returnvalue">GMimeStream</span></a> *
g_mime_data_wrapper_get_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);</pre>
<p>Gets a reference to the stream wrapped by <em class="parameter"><code>wrapper</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-get-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>wrapper</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-data-wrapper-get-stream.returns"></a><h4>Returns</h4>
<p>a reference to the internal stream. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-data-wrapper-set-encoding"></a><h3>g_mime_data_wrapper_set_encoding ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_data_wrapper_set_encoding (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
                                  <em class="parameter"><code><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="type">GMimeContentEncoding</span></a> encoding</code></em>);</pre>
<p>Sets the encoding type of the internal stream.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-set-encoding.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wrapper</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>encoding</p></td>
<td class="parameter_description"><p>encoding</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-data-wrapper-get-encoding"></a><h3>g_mime_data_wrapper_get_encoding ()</h3>
<pre class="programlisting"><a class="link" href="gmime-gmime-encodings.html#GMimeContentEncoding" title="enum GMimeContentEncoding"><span class="returnvalue">GMimeContentEncoding</span></a>
g_mime_data_wrapper_get_encoding (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>);</pre>
<p>Gets the encoding type of the stream wrapped by <em class="parameter"><code>wrapper</code></em>
.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-get-encoding.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>wrapper</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-data-wrapper-get-encoding.returns"></a><h4>Returns</h4>
<p> the encoding type of the internal stream.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-data-wrapper-write-to-stream"></a><h3>g_mime_data_wrapper_write_to_stream ()</h3>
<pre class="programlisting"><span class="returnvalue">ssize_t</span>
g_mime_data_wrapper_write_to_stream (<em class="parameter"><code><a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a> *wrapper</code></em>,
                                     <em class="parameter"><code><a class="link" href="GMimeStream.html" title="GMimeStream"><span class="type">GMimeStream</span></a> *stream</code></em>);</pre>
<p>Writes the raw (decoded) data to the output stream.</p>
<div class="refsect3">
<a name="g-mime-data-wrapper-write-to-stream.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>wrapper</p></td>
<td class="parameter_description"><p>a <a class="link" href="GMimeDataWrapper.html" title="GMimeDataWrapper"><span class="type">GMimeDataWrapper</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream</p></td>
<td class="parameter_description"><p>output stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-data-wrapper-write-to-stream.returns"></a><h4>Returns</h4>
<p> the number of bytes written or <code class="literal">-1</code> on failure.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeDataWrapper.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMimeDataWrapper-struct"></a><h3>struct GMimeDataWrapper</h3>
<pre class="programlisting">struct GMimeDataWrapper;</pre>
<p>A wrapper for a stream which may be encoded.</p>
<div class="refsect3">
<a name="GMimeDataWrapper.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GMimeDataWrapper.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GMimePart.html" title="GMimePart"><span class="type">GMimePart</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>